<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::StateEngine::AddedStateVariable Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html">AddedStateVariable</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_s_p_h_1_1_state_engine_1_1_added_state_variable-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::StateEngine::AddedStateVariable Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Class for handling state variable added (allocated) by this <a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a>.  
 <a href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="state__engine_8h_source.html">state_engine.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html">SPH::StateEngine::StateVariable</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a5122a8075367eccb977b281f94b4f5dc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html#a5122a8075367eccb977b281f94b4f5dc">AddedStateVariable</a> ()</td></tr>
<tr class="separator:a5122a8075367eccb977b281f94b4f5dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa88ca53417aa1e4470b8b65c1f6c733"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html#afa88ca53417aa1e4470b8b65c1f6c733">AddedStateVariable</a> (std::string &amp;name, <a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a> &amp;owner, SimTK::Stage invalidatestage)</td></tr>
<tr class="separator:afa88ca53417aa1e4470b8b65c1f6c733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a993eab162a075588c8729814d66cf5cf"><td class="memItemLeft" align="right" valign="top">Real&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html#a993eab162a075588c8729814d66cf5cf">getValue</a> () override</td></tr>
<tr class="separator:a993eab162a075588c8729814d66cf5cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a287c41489c3d4403c73c2a7aaf965705"><td class="memItemLeft" align="right" valign="top"><a id="a287c41489c3d4403c73c2a7aaf965705"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>setValue</b> (Real value) override</td></tr>
<tr class="separator:a287c41489c3d4403c73c2a7aaf965705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47c8b21c1343a608ae949b6c9a3340d3"><td class="memItemLeft" align="right" valign="top"><a id="a47c8b21c1343a608ae949b6c9a3340d3"></a>
Real&#160;</td><td class="memItemRight" valign="bottom"><b>getDerivative</b> () override</td></tr>
<tr class="separator:a47c8b21c1343a608ae949b6c9a3340d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c6431798f4fa0e822b31af63733c174"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_added_state_variable.html#a6c6431798f4fa0e822b31af63733c174">setDerivative</a> (Real deriv) override</td></tr>
<tr class="separator:a6c6431798f4fa0e822b31af63733c174"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html">SPH::StateEngine::StateVariable</a></td></tr>
<tr class="memitem:a2d41a4902b7b2390e46a3a4cffc545e2 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a2d41a4902b7b2390e46a3a4cffc545e2">StateVariable</a> ()</td></tr>
<tr class="separator:a2d41a4902b7b2390e46a3a4cffc545e2 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a5991917224e433bb6fc78d5c60117c inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a6a5991917224e433bb6fc78d5c60117c">StateVariable</a> (std::string &amp;name, <a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a> &amp;owner, SimTK::SubsystemIndex subsys, <a class="el" href="classint.html">int</a> varindex)</td></tr>
<tr class="separator:a6a5991917224e433bb6fc78d5c60117c inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf903e4eceaeadec1aabf4ddbdd43625 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top"><a id="aaf903e4eceaeadec1aabf4ddbdd43625"></a>
std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getName</b> ()</td></tr>
<tr class="separator:aaf903e4eceaeadec1aabf4ddbdd43625 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c881036c705d8cd27d23c5b39e68942 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top"><a id="a8c881036c705d8cd27d23c5b39e68942"></a>
<a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>getOwner</b> ()</td></tr>
<tr class="separator:a8c881036c705d8cd27d23c5b39e68942 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a257b7931903872ecbb33169c0c55ecff inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classint.html">int</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a257b7931903872ecbb33169c0c55ecff">getVarIndex</a> ()</td></tr>
<tr class="separator:a257b7931903872ecbb33169c0c55ecff inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaabc2de09769911c1976c0c4f219a9f5 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">SimTK::SubsystemIndex &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#aaabc2de09769911c1976c0c4f219a9f5">getSubsysIndex</a> ()</td></tr>
<tr class="separator:aaabc2de09769911c1976c0c4f219a9f5 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f3b85d255fad9a5ffde8f505ad39d5e inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">SimTK::SystemYIndex &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a6f3b85d255fad9a5ffde8f505ad39d5e">getSystemYIndex</a> ()</td></tr>
<tr class="separator:a6f3b85d255fad9a5ffde8f505ad39d5e inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8bc2546454638b0775eb8d712c45b7ab inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a8bc2546454638b0775eb8d712c45b7ab">setVarIndex</a> (<a class="el" href="classint.html">int</a> index)</td></tr>
<tr class="separator:a8bc2546454638b0775eb8d712c45b7ab inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d31c2917b8ba7ff3788be0b889950a2 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a4d31c2917b8ba7ff3788be0b889950a2">setSubsystemIndex</a> (SimTK::SubsystemIndex &amp;subsysindx)</td></tr>
<tr class="separator:a4d31c2917b8ba7ff3788be0b889950a2 inherit pub_methods_class_s_p_h_1_1_state_engine_1_1_state_variable"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class for handling state variable added (allocated) by this <a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5122a8075367eccb977b281f94b4f5dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5122a8075367eccb977b281f94b4f5dc">&#9670;&nbsp;</a></span>AddedStateVariable() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SPH::StateEngine::AddedStateVariable::AddedStateVariable </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructors adn destrucutors. </p>

</div>
</div>
<a id="afa88ca53417aa1e4470b8b65c1f6c733"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa88ca53417aa1e4470b8b65c1f6c733">&#9670;&nbsp;</a></span>AddedStateVariable() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">SPH::StateEngine::AddedStateVariable::AddedStateVariable </td>
          <td>(</td>
          <td class="paramtype">std::string &amp;&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a> &amp;&#160;</td>
          <td class="paramname"><em>owner</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">SimTK::Stage&#160;</td>
          <td class="paramname"><em>invalidatestage</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Convenience constructor for defining a <a class="el" href="class_s_p_h_1_1_state_engine.html">StateEngine</a> added state variable &lt; stage this variable invalidates. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>state var name. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a993eab162a075588c8729814d66cf5cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a993eab162a075588c8729814d66cf5cf">&#9670;&nbsp;</a></span>getValue()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">Real SPH::StateEngine::AddedStateVariable::getValue </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>override virtual methods. </p>

<p>Implements <a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a559cf846fd352572efdc12f6e3a4428c">SPH::StateEngine::StateVariable</a>.</p>

</div>
</div>
<a id="a6c6431798f4fa0e822b31af63733c174"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c6431798f4fa0e822b31af63733c174">&#9670;&nbsp;</a></span>setDerivative()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void SPH::StateEngine::AddedStateVariable::setDerivative </td>
          <td>(</td>
          <td class="paramtype">Real&#160;</td>
          <td class="paramname"><em>deriv</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>The derivative a state should be a cache entry and thus does not change the state. </p>

<p>Implements <a class="el" href="class_s_p_h_1_1_state_engine_1_1_state_variable.html#a2d62b3cad319eadaf19e6d0bb15da53e">SPH::StateEngine::StateVariable</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/simbody/<a class="el" href="state__engine_8h_source.html">state_engine.h</a></li>
<li>SPHINXsys/src/shared/simbody/state_engine.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
